home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / bbsutils / dizit33.arj / DIZIT.DOC < prev    next >
Text File  |  1994-02-28  |  16KB  |  347 lines
  1.                               DizIt v3.3
  2.                        
  3.                       For PCBoard v14.5a and 15.x
  4.  
  5.                                     By
  6.  
  7.                               Copyright 1994
  8.                                 Robert Neal
  9.                                 317 Hickory
  10.                            Romeoville, IL  60441
  11.  
  12.                                 Support BBS:
  13.                                 CorpSoft BBS
  14.                   Node #1: (815) 886-3233  14400 v.32bis
  15.                   Node #2: (815) 886-9381  28800 v.fc
  16.  
  17.  
  18. |       Text marked with "|" indicates a change since last version.
  19.  
  20.  
  21. Sysops upgrading from DizIt v1.x should refer to documentation for
  22. changes as v2.0 was a major rewrite of how DizIt processed files. Sysops
  23. upgrading from v2.x should not need to do anything other than copy the
  24. new .EXE's into your DizIt directory. You may want to run the new
  25. DIZCFG.EXE on each of your .CFG files, but this should not be required
  26. for most sysops.
  27.  
  28.  
  29.                             PROGRAM INFORMATION
  30.                             ===================
  31.  
  32. As a sysop, you've probably downloaded hundreds of files to add to your
  33. board. You've probably used the local upload option in PCBoard to add
  34. these files to your system, or you've used PCBFiler to read the new
  35. files and manually typed in each file description. But with many files
  36. now including their own description file, FILE_ID.DIZ and DESC.SDI,
  37. wouldn't it be nice to have a program do all the work for you?
  38.  
  39. DizIt is a utility written for PCBoard v14.5a and PCBoard 15.x to do
  40. just that. DizIt was written to aid sysops in adding files, up to 2,500 
  41. at a time,  which contain FILE_ID.DIZ or DESC.SDI into their upload 
  42. directory from the command line.
  43.  
  44. Additionally, if FILE_ID.DIZ or DESC.SDI is not found in an archived
  45. file, DizIt can be configured to scan a text file, that is in PCBoard
  46. directory format, and import descriptions directly from that file. Great
  47. for importing files from captured file listings of other BBS, file
  48. listings from CDROM's, etc. Text files do NOT need to include the "|"
  49. character which PCBoard requires. DizIt will import any file which
  50. includes the description starting in the 34th column.
  51.  
  52. The entire process is simple to do, even easier than using the
  53. "local upload" option of PCBoard, plus offers the import from file
  54. function that the local upload function doesn't.
  55.  
  56. If no description is found DizIt will do no further processing of the
  57. file except for moving the file to the holding directory you've
  58. indicated. This allows you to place all your files you want to add in
  59. the directory and let DizIt search for those that can be automatically
  60. added to your PCB File directory listing.
  61.  
  62. Currently, DizIt is written to process FILE_ID.DIZ and DESC.SDI from ZIP
  63. and ARJ archived files. Based on my experiences, the majority of files
  64. being distributed are in these two formats and these two formats will
  65. suffice for almost all PCBoard sysops. If you would like to see another
  66. format included, please feel free to write me and I'll look to add the
  67. format to DizIt.
  68.  
  69. While DizIt will not search for the FILE_ID.DIZ and DESC.SDI for files
  70. other than .ZIP and .ARJ, it will quickly scan the file listing for
  71. descriptions to import. Great for importing .GIF, .EXE, .LHA, .TXT, etc.
  72. into your PCBoard upload directory.
  73.  
  74.  
  75.  
  76.                         PROGRAM INSTALLATION/OPERATION
  77.                         ==============================
  78.  
  79. INSTALL
  80. -------------------------
  81.  
  82. Place the DIZIT files into a directory in your path. You may place DIZIT
  83. in it's own directory if you so choose, but you must be sure to properly
  84. configure the batch files to make the call to the proper directory when
  85. running DIZIT.
  86.  
  87. Ensure that the appropriate archiving programs are available in your
  88. directory path. For ZIP files, you'll need PKZIP.EXE and PKUNZIP.EXE.
  89. For ARJ files you'll need ARJ.EXE. DIZIT makes a call to these programs
  90. to extract the description files as well as importing your BBS comment
  91. file.
  92.  
  93.  
  94.  
  95. CREATE CONFIGURATION FILE
  96. --------------------------
  97.  
  98. Edit DizIt configuration file, DizIt.CFG. Use the program DIZCFG.EXE
  99. contained with this archive to edit this file or use your favorite text
  100. editor to edit this file.
  101.  
  102. The items in the configuration file are as follows, do not include the
  103. line number references. Refer to detailed explanation below for each
  104. line:
  105.  
  106.         DizIt.CFG
  107.         --------------------------
  108. Line 1: CorpSoft BBS
  109. Line 2: 0
  110. Line 3: G:\WORK
  111. Line 4: C:\UPLOAD
  112. Line 5: C:\HOLD
  113. Line 6: D:\PCB\MAIN\UPLD
  114. Line 7: D:\BBS.CMT
  115. Line 8: D:\IMPFILE
  116. Line 9: D:\DIZIT\DIZIT.LOG
  117.  
  118. Line 1: BBS Name
  119.  
  120. Line 2: Registration number, leave as 0 if unregistered.
  121.  
  122. Line 3: Drive/path to be used for temporary work area. A RAM disk, if
  123.         available, is recommended. Ensure that this directory exists
  124.         before using DizIt. Do not include the trailing "\" at the
  125.         end of the directory name.
  126.  
  127. Line 4: Drive/path of where files are to be moved to once they are
  128.         processed. This could be your public upload directory, private
  129.         directory or any other directory you choose. Again, ensure that
  130.         this directory exists before using DizIt. Do not include the
  131.         trailing "\" at the end of the directory name.
  132.  
  133. Line 5: Drive/path of where files should be moved if either FILE_ID.DIZ
  134.         or DESC.SDI is not found. Enter "NONE" on this line if you want
  135.         DIZIT to keep the files in the directory they are currently
  136.         located.
  137.  
  138. Line 6: Full path/filename of the file to which is to be updated with
  139.         the files imported. Typically this will be your public upload
  140.         directory, but you may want to instead move the files to your
  141.         private upload directory so that you may preview the files
  142.         before making them public. This file should relate to the
  143.         directory choosen above.
  144.  
  145. Line 7: Full path/filename of a comment file you want to have added to
  146.         the ZIP file. Typically, this may be your "BBS AD" comment.
  147.         Enter NONE if you do not wish to use this option.
  148.  
  149. Line 8: Full path/filename of a text file to be scan and descriptions
  150.         extracted from for import. File must be in PCBoard file
  151.         directory format. Enter NONE if you do not wish to use this
  152.         feature.
  153.  
  154. Line 9: Log file for DizIt, records name of files imported and if
  155.         description file was found or not.
  156.  
  157.  
  158.  
  159. PROGRAM OPERATION
  160. ------------------
  161.  
  162. Move all files to be processed into a temporary file directory. This
  163. directory should only contain files you wish to have imported into your
  164. PCBoard directory.
  165.  
  166. Enter the following command at the DOS prompt:
  167.  
  168. DIZIT DIZIT.CFG C:\DIZTEMP *.ZIP
  169. ----- --------- ---------- -----
  170.   ^       ^          ^      ^
  171.   |       |          |       \Wildcard to be used (optional - default="*.*")
  172.   |       |          \ Directory containing files to be processed
  173.   |        \ Name of your configuration file
  174.    \ Name you have used for the DizIt .EXE program
  175.  
  176.   
  177.  
  178. Once the prorgam starts, it will read the names of all files in your
  179. temporary file directory. DizIt will then, if instructed, add the ZIP
  180. COMMENT specified on line 7 of the DizIt.CFG file to the ZIP file.
  181.  
  182. DizIt will then check the ZIP or ARJ file to see if the FILE_ID.DIZ or
  183. DESC.SDI file exists in the ZIP or ARJ file. If the file is not a ZIP or
  184. ARJ archived file, DizIt will skip to the next process listed below. If
  185. FILE_ID.DIZ or DESC.SDI is found, DizIt will extract the file to your
  186. temporary work directory and then begin to add the file to the end of
  187. your PCBoard file directory indicated in the configuration file. Unlike
  188. other similar programs, DizIt will update your PCBoard file listing with
  189. the file size and the current date of the upload, no further processing
  190. of the PCBoard file directory list is required.
  191.  
  192. If FILE_ID.DIZ or DESC.SDI is not found, DizIt will optionally scan the
  193. text file indicated in line 8 of the DIZIT.CFG file for filename
  194. matches. If a match is found, DizIt will automatically import the
  195. description from the text file.
  196.  
  197. Once DizIt has imported the file and description into your PCBoard file
  198. directory list, DizIt will move the file from the current directory to
  199. the directory specified in line 4 in the configuration file.
  200.  
  201.  
  202.  
  203.                               REGISTRATION
  204.                               ============
  205.  
  206. DizIt is released as user support software (aka SHAREWARE). I don't
  207. expect you to register the program if you don't like it or if it doesn't
  208. meet your needs (just stop using it). But if you continue to use DizIt
  209. after a reasonable evaluation period of up to 30 days, you are required
  210. to make payment for the program or stop using it.
  211.  
  212. DizIt is NOT crippled in any way other than a marker "->DizIt" will be
  213. added to the last line of the file description field. This function has
  214. been added as an incentive to register the program. Once you have
  215. registered the program, the marker will no longer added to the imported
  216. description.
  217.  
  218. Registration is only $10 and will include unlimited free upgrades and
  219. support via my BBS. Many hours have gone into making DizIt what sysops
  220. have been asking for. It can save you hours of time in uploading files
  221. to your board locally, and your time saved should more than offset the
  222. $10 price.
  223.  
  224. Please use the form REGISTER.FRM included with the program to register
  225. DizIt. If this file is missing, send a check for $10 (US funds) to:
  226.  
  227.         Robert Neal
  228.         317 Hickory
  229.         Romeoville, IL  60441
  230.  
  231. Please include your BBS name as this information will be used to create
  232. your unique registration key file. You may receive your registration
  233. file via my support BBS (but please be sure you have an account
  234. established on my BBS so that I can leave this information in a private
  235. message to you) or via the US Mail. Please indicate your preference.
  236.  
  237. Keep your eye open for other utility programs from me written for
  238. PCBoard. Several programs are now in the works and should be released
  239. soon. Also, look for my door programs, Card Sharks and Links Golf
  240. (available on my BBS as well), I think your users will enjoy playing
  241. them. See the file OTHER.TXT for a listing of all my currently available
  242. programs.
  243.  
  244. You may register online with your Visa or MasterCard by calling my BBS
  245. and typing CHARGE at the main menu prompt.
  246.  
  247.  
  248.  
  249.                                   SUPPORT
  250.                             ===================
  251.  
  252. If you have any questions, comments, problems, suggestions for
  253. enhancements, etc., I may be reached at my support BBS or by mail. In
  254. addition, you may send a message to me on the RIME conferences to my BBS
  255. "CHQBBS", I regularly monitor the messages in the Sysop, BBS and PCBoard
  256. Support conferences. I can also be reached via Prodigy.
  257.  
  258. I can also be reached via Internet mail at bob.neal@corpsoft.com.
  259.  
  260.  
  261.                              LEGAL INFORMATION
  262.                       ===============================
  263.  
  264. This program is provided on an "AS IS" basis.  No warranty of any kind is
  265. expressed or implied.  YOU USE THIS PROGRAM AT YOUR OWN RISK.  I take no
  266. responsibility for any damage caused directly or indirectly from the use or
  267. the inability to use this program.
  268.  
  269.  
  270.  
  271. VERSION HISTORY:
  272.  
  273.         v1.0 - Initial release
  274.         v1.1 - Fixed bug where if NONE was selected as the directory to
  275.                  move files to, DIZIT would rename file to NONE.
  276.                If DIZIT processed a file at the same time that the
  277.                  PCBoard upload directory was being browsed on a 2nd
  278.                  node, DIZIT would return error. Revised file handling
  279.                  so that this no longer occurs - DIZIT updates file
  280.                  without an error.
  281.         v2.0 - Rewrite of original code for improved status display and
  282.                  speed.
  283.                Added option to scan text file listing for descriptions
  284.                  to be imported if FILE_ID.DIZ or DESC.SDI file is not
  285.                  found.
  286.                Program now includes internal routines to read directory
  287.                  information. No need to use batch files to process a
  288.                  group of files.
  289.                Added LOG FILE feature.
  290.         v2.1 - Added option to disable the import descriptions and BBS
  291.                  ad file.
  292.         v3.0 - Greatly increased number of files that could be imported
  293.                  at one time. Previously I had set this to 250 records,
  294.                  but several sysops have had reason to import more than
  295.                  this at one time. DizIt now supports up to 2,500 files
  296.                  imports at one time (have only verified this with
  297.                  1,400 records - I have nothing that has 2,500 files
  298.                  to be checked at once, nor the disc space <g>).
  299.                DizIt will trim extra spaces from the description file if
  300.                  it is left padded with spaces. For example, a record
  301.                  "      This is a great file"
  302.                  is imported as
  303.                  "This is a great file".
  304.                Revamped error routines to verify files/paths specified
  305.                  in configuration file. If an error occurs, an
  306.                  explanation is now shown explaining which file/path was
  307.                  missing and then cleanly exit for you to correct.
  308.                Rewrote file routine to allow any file extension to have
  309.                  their file description from the text file if specified.
  310.                  This now allows .EXE, .GIF, .TXT, .LHA, etc to be
  311.                  quickly imported into your PCBoard upload directory.
  312.                  These files will not be checked for FILE_ID.DIZ or
  313.                  DESC.SDI and will only have descriptions imported from
  314.                  the text file. Only .ZIP and .ARJ files will be
  315.                  searched for the FILE_ID.DIZ and DESC.SDI files.
  316.                Added file DIZCFG.EXE, an editor for your DizIt
  317.                  configuration files. No more need to refer to the
  318.                  documentation each time, DIZCFG.EXE has a brief
  319.                  explanation of each line in the configuration file and
  320.                  allows you to edit/enter data.
  321.                Found that DizIt would not properly operate under DRDOS.
  322.                  The routines used to copy the files to the directories
  323.                  specified would result in files being lost. The routine
  324.                  worked fine under MSDOS. What worked under DRDOS then
  325.                  didn't work under MSDOS - go figure. Changed routine so
  326.                  that it now handles either DOS version correctly.
  327.         v3.1 - If a file was marked as NONE in configuration, the
  328.                  validation rotuine would try to process the
  329.                  information and return an error message. Revised
  330.                  routine to accomodate this.
  331.         v3.2 - Left in some debug code that resulted in bypassing my
  332.                  error routine. Result, if you improperly set up DIZIT
  333.                  the program was unable to report what configuration
  334.                  option was improperly set. Error routine should now
  335.                  execute - while I was in the code caught a few more
  336.                  possibilities as to how an error could be generated and
  337.                  now check for them as well. Let me know if any errors
  338.                  go unreported by the program.
  339.         v3.3 - Added routine that verifies disk space available before
  340.                  copying files. If space is insufficient, DizIt will bypass
  341.                  the file and make a notation in the DizIt log file.
  342.                Noticed that I had accidentally deleted the "2" in my
  343.                  dimensions for the number of files to be processed.
  344.                  Subsequently, since v3.1 the number that DizIt could process
  345.                  at one time has been set to 500 instead of 2500. DizIt
  346.                  will once again process up to 2500 files at once.
  347.